/*
 * Copyright 2011 broc.seib@gentomi.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.twilio4j.twism;

/**
 * Twilio will pass the following parameters in addition to the standard TwiML Voice request parameters with its request to the 'transcribeCallback' URL of {@link com.twilio4j.twiml.Record}.
 * 
 * @author broc.seib@gentomi.com
 *
 */
public interface TranscribeParameters {
	/**
	 * @return Contains the text of the transcription.
	 */
	public String getTranscriptionText();
	/**
	 * @return The status of the transcription attempt: either 'completed' or 'failed'. These are enumerated in {@link TranscriptionStatus}.
	 */
	public TranscriptionStatus getTranscriptionStatus();
	/**
	 * @return The URL for the transcription's REST API resource.
	 */
	public String getTranscriptionUrl();
	/**
	 * @return The URL for the transcription's source recording resource.
	 */
	public String getRecordingUrl();
}
